home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr27 / prokez17.zip / PRO-KEYS.DOC < prev    next >
Text File  |  1995-03-01  |  10KB  |  305 lines
  1.  
  2.                                Pro-Keys Version 1.7
  3.  
  4.                       Copyright (c) 1993 by Randy S. Gregory
  5.                                All Rights Reserved.
  6.  
  7.                       ──────────────────────────────────────
  8.  
  9.                   This copy of Pro-Keys is unregistered Shareware.
  10.  
  11.               To obtain a registered copy of Pro-Keys send $19.95 to:
  12.  
  13.                               Mr. Randy S. Gregory
  14.                               20 College Drive, Apt. 28
  15.                               Platteville, Wisconsin 53818
  16.                               U.S.A.
  17.  
  18. INSTALLATION
  19. ────────────
  20.  
  21.   PROKEZ17.ZIP contents:
  22.  
  23.     1.) PRO-KEYS.EXE - Main program.
  24.     2.) PRO-KEYS.NXB - Same as above, without extended keyboard buffer support.
  25.     3.) PRO-KEYS.DOC - Documentation.
  26.     4.) PRO-KEYS.CFG - Configuration file.
  27.     5.) PRO-KEY2.EXE - Support file, must reside in the same directory as
  28.                        the main program PRO-KEYS.EXE.
  29.     6.) FILE_ID.DIZ  - Dizcription file.
  30.  
  31.   Suggested installation:
  32.  
  33.     1.) If you are using a previous version of Pro-Keys first backup your
  34.         PRO-KEYS.CFG file.
  35.     2.) Remove other installed command line utilities (including older versions
  36.         of Pro-Keys).
  37.     3.) Make a PRO-KEYS subdirectory.
  38.     4.) Unzip PROKEZ17.ZIP into the PRO-KEYS subdirectory.
  39.     5.) Add the statement C:\PRO-KEYS\PRO-KEYS to your autoexec.bat file.
  40.     6.) For users who don't want extended keyboard buffer support, I have
  41.         encluded PRO-KEYS.NXB.  Simply rename PRO-KEYS.NXB to PRO-KEYS.EXE.
  42.     7.) Reboot.
  43.  
  44. FEATURES
  45. ────────
  46.  
  47.   Uses 6.2K with extended keyboard buffer support, and 5.5K without.
  48.  
  49.   User definable history buffer size (from 1..250 commands)
  50.  
  51.   DOSKEY compatible macros.
  52.  
  53.   Extended keyboard buffer (100 keystrokes).
  54.    For users who don't want extended keyboard buffer support, I have
  55.    encluded PRO-KEYS.NXB.  Simply rename PRO-KEYS.NXB to PRO-KEYS.EXE.
  56.  
  57.   Sets the keyboard delay and repeat rate to the fastest setting.
  58.  
  59.   Uses time-slicing techniques so CPU cycles aren't wasted under
  60.    multitasking operating systems.
  61.  
  62.   Make configuration changes on the fly (no rebooting or reloading necessary).
  63.  
  64.   User definable function keys <F2>-<F12>.
  65.  
  66.   /U switch unloads Pro-Keys.
  67.  
  68.   Two methods of command completion: 1.) Auto
  69.                                       2.) Tab-only
  70.  
  71.     The first method completes a command automatically while you are typing.
  72.     The completion process may be interupted by keystrokes, hence, there are
  73.     no delays while typing.  This method usually results in a "hit" within a
  74.     few keystrokes.  The second method completes a command only when <Tab> is
  75.     pressed.
  76.  
  77.       The following search order is used for completions:
  78.  
  79.        1.) The history buffer.
  80.             A.) with location sensitivity.
  81.             B.) without location sensitivity.
  82.        2.) The default directory.
  83.        3.) The directories on the path.
  84.  
  85.   User definable command completion rules.
  86.  
  87.   Forward-slash or back-slash mode.
  88.  
  89.   Enter multiple commands on one line separated by semicolons.
  90.  
  91.  
  92. COMMAND SUMMARY
  93. ───────────────
  94.  
  95.   <Left Arrow> and <Right Arrow> move left and right within the command line.
  96.  
  97.   <Home> moves to the beginning of the command line.
  98.  
  99.   <End> or <[> moves to the end of the command line.  The left bracket
  100.    character has been moved to <Alt-[>.
  101.  
  102.   <Esc> clears the command line.
  103.  
  104.   <Insert> toggles between insert (the default) and overwrite modes.
  105.  
  106.   <Up Arrow> and <Down Arrow> at a blank command line cycles through the
  107.    command history.  At a non-blank command line <Up Arrow> and <Down Arrow>
  108.    function the same as <Tab> and <Shift-Tab>.
  109.  
  110.   <F1> displays the list of current function key assignments.
  111.  
  112.   <F2>..<F12>,<Tab>  User definable function keys.  Defined in PRO-KEYS.CFG.
  113.  
  114.   <`> searches the command history for the current command line.  Displays
  115.    the ten most frequently used matches.  Pressing <0>..<9> brings the selected
  116.    history item to the command line.  The accent mark has been moved to <Alt-`>.
  117.  
  118.   Pressing a function key applies that keys function to the current
  119.    command line.  A function key may also be used alone.
  120.  
  121.   Typing a space at the beginning of the command line disables command line
  122.    completion until <Enter> or <Esc> is typed.
  123.  
  124.   After using one of the completion methods, <Enter> on a valid directory
  125.    moves to that directory.  <Enter> on a non .EXE, .BAT, or .COM file
  126.    auto-edits that file.
  127.  
  128.   <Tab> immediately attempts to complete a command.  If the command has
  129.    already been completed, <Tab> cycles through other possible completions.
  130.  
  131.   <Shift-Tab> back tracks through the last ten completions.  Handy if you
  132.    mistakenly hit <Tab> to many times.
  133.  
  134.   <Alt-A> toggles between auto-completion and Tab-only completion methods.
  135.  
  136.   <Alt-C> cycles through command line text colors.  The command line color
  137.    is saved in PRO-KEYS.CFG as "CmdColor".
  138.  
  139.   After using one of the completion methods, <Alt-R>, <Alt-H>, and <Alt-S>
  140.    toggle file attributes (ReadOnly, Hidden, System) of the currently completed
  141.    file.
  142.  
  143.   <Alt-Shift-Esc> exits a ("locked-up") program and returns to the command
  144.    line.
  145.  
  146.  
  147. USAGE EXAMPLES
  148. ──────────────
  149.  
  150. Example 1:
  151.  
  152.       user types : <m>
  153.         response : myfile.dat      [C:\]
  154.       user types : <F3>       (assigned the DOS TYPE command in PRO-KEYS.CFG)
  155.         response : type c:\myfile.dat      (C:\MYFILE.DAT is typed.)
  156.  
  157. Example 2:
  158.  
  159.       user types : <g>
  160.         response : goodies\     [C:\]     (goodies is a sub-directory)
  161.       user types : <Enter>
  162.         response : C:\GOODIES>      (C:\GOODIES is made the default directory.)
  163.  
  164. Example 3:
  165.  
  166.       user types : <y>
  167.         response : yourfile.dat    [C:\]
  168.       user types : <Enter>
  169.         response : e c:\yourfile.dat     (auto-edits C:\YOURFILE.DAT using the
  170.                                           editor specified in PRO-KEYS.CFG)
  171. Example 4:
  172.  
  173. Adding an exclamation point <!> to the beginning of a function key definition
  174. in PRO-KEYS.CFG will cause a verification message to be presented each time
  175. that function key is pressed.
  176.  
  177.       F8 =!del
  178.  
  179.       user types : <a>
  180.         response : afile.dat      [C:\]
  181.       user types : <F8>
  182.         response : del c:\afile.dat ? (y/n)
  183.       user types : <n>     (C:\AFILE.DAT is not deleted.)
  184.  
  185.  
  186. PRO-KEYS.CFG DESCRIPTION
  187. ────────────────────────
  188.  
  189. NOTE: Changes to PRO-KEYS.CFG are effective immediately.
  190.  
  191. SAMPLE PRO-KEYS.CFG
  192. ───────────────────
  193. F2       =e
  194. F3       =more < $1
  195. F4       =!print
  196. F5       =dir
  197. F6       =rename
  198. F7       =deltree
  199. F8       =!del
  200. F9       =zip
  201. F10      =unzip
  202. F11      =mode 80,25
  203. F12      =mode 80,50
  204. Tab      =dir/w
  205. Editor   =e
  206. Delay    =30
  207. CmdColor =14
  208. History  =200
  209. Slash    =\
  210. Complete=
  211. *.exe *.com *.bat *.doc *.dat *.cfg * *.*
  212. zip *.zip
  213. unzip *.zip
  214. e *.doc *.txt *.me *.dat *.bat *.cfg * *.* /f
  215. rd *.* /d /np /nh
  216. cd *.* /d /np /nh
  217. deltree *.* /d
  218. Macros=
  219. ls=dir $*
  220. rm=del $1
  221. ───────────────────
  222.  
  223. "F2-F12"
  224. Defines the function keys <F2> through <F12>.  Function key definitions may
  225. contain special macro codes.  See "Macros" below.
  226.  
  227. "Tab"
  228. Defines the <Tab> key.  Note, this definition is only active at a blank command
  229. line.
  230.  
  231. "Editor"
  232. Defines the editor used by the auto-edit feature described above in the
  233. Command Summary section.
  234.  
  235. "Delay"
  236. The amount of time in hundredths of a second after a keypress before
  237. auto-completion activates.  Defined as 'disabled ##' when Tab-only completion
  238. is active. See <Alt-A> in the "Command Summary" section about toggling
  239. between the two completion methods.
  240.  
  241. "CmdColor"
  242. An integer representing the current text color of the command line.
  243. See <Alt-C> in the "Command Summary" section about changing this color.
  244.  
  245. "History"
  246. The number of commands maintained in the history buffer (must be <= 250).
  247.  
  248. "Slash"
  249. Defined as either '\' or '/'.
  250. For normal DOS functionality define as '\'.
  251. For Unix-like functionality define as '/'.
  252. '/' mode notes: The '-' switch character must be used in place of the '/'
  253.                 switch character.  The '\' character is unavailable.
  254.  
  255. "Complete"
  256. Command completion rules.  The first line is the default rule, used when no
  257. custom rule applies.  Rules listed after the default rule are custom rules and
  258. have the syntax:  COMMAND *.EXT [*.EXT ...] [/F|/D] [/NH] [/NP]
  259. Parameters: /F  = Files only.
  260.             /D  = Directories only.
  261.             /NH = No history buffer search.
  262.             /NP = No path search, only the current directory is searched.
  263. Note: File types are completed in the order listed.
  264.  
  265. "Macros"
  266. The following are some special codes in Pro-Keys macro definitions:
  267. $T or ;  Separates multiple commands in a macro.
  268. $1-$9    Equivalent to %1-%9 in batch files.
  269. $*       This symbol is replaced by everything following the macro name.
  270.  
  271.  
  272. REGISTRATION
  273. ────────────
  274.  
  275. To register, send a check or money order in the amount of $19.95 to:
  276.  
  277.      Mr. Randy S. Gregory
  278.      20 College Drive, Apt. 28
  279.      Platteville, Wisconsin 53818
  280.      U.S.A.
  281.  
  282. When registering please specify delivery method:
  283.  
  284.    1.) E-Mail : Include E-Mail address and attachment method.
  285.    2.) Mail   : Include postal address and media type (3½ or 5¼, and density).
  286.  
  287. Upon registration you will receive the latest version of Pro-Keys, and are
  288. entitled to free Pro-Keys updates (including new versions and maintenance
  289. releases).
  290.  
  291.  
  292. DISCLAIMER
  293. ──────────
  294.  
  295. The author of Pro-Keys shall not be liable in the event of incidental or
  296. consequential damages in connection with, or arising out of, the use of
  297. Pro-Keys.
  298.  
  299.  
  300. CONTACTING THE AUTHOR
  301. ─────────────────────
  302.  
  303. If you have ideas, questions, comments, or problems email.me@
  304. <RANDY@agecon.wisc.edu>
  305.